home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / dosutils / twp100.zip / OBJEDIT.HLP (.txt) < prev    next >
OS/2 Help File  |  1996-01-23  |  19KB  |  509 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Cover ΓòÉΓòÉΓòÉ
  3.  
  4.                               "Traveling Workplace"
  5.                                   Object Editor
  6.                                   Version 1.00
  7.                   Copyright (c) Syntegration 1993, 1994, 1995.
  8.                               All Rights Reserved.
  9.                             3811 Schaefer Avenue, #J
  10.                              Chino, California 91710
  11.                                      U.S.A.
  12.                                 Tel: 909-464-9450
  13.                                 Fax: 909-627-3541
  14.                         E-Mail:73707.3331@COMPUSERVE.COM
  15.  
  16.  
  17. ΓòÉΓòÉΓòÉ 2. License Agreement and Limited Warranty ΓòÉΓòÉΓòÉ
  18.  
  19. This program, including its code and documentation, appearance, structure and 
  20. organization is a product of Syntegration and is protected by copyright and 
  21. other laws. Title to the program or any copy, modification or merged portion of 
  22. the program shall at all times remain with Syntegration. 
  23.  
  24. LICENSE - The following restricted rights are granted: 
  25.  
  26. You may: 
  27.  
  28.  1. Use the Program only on a single computer. The Program may be transferred 
  29.     to and used on another computer as long as the program is de-installed from 
  30.     the original computer, and under no circumstances be used on more than one 
  31.     computer at a time. 
  32.  
  33.  2. If you purchased an Enterprise Edition license for this Program, you may 
  34.     use the Program on as many computers as you have licensed. 
  35.  
  36.  3. Transfer the Program with this license to another person, but only if the 
  37.     other person agrees to accept the terms and conditions of this agreement. 
  38.     If you transfer the Program and License, you must at the same time either 
  39.     transfer all copies of the program and its documentation to the same person 
  40.     or destroy those not transferred. Any transfer terminates your license. 
  41.  
  42.  4. Include the program as part of a system that you resell. If you include the 
  43.     program as part of another system you must include this license agreement, 
  44.     acknowledge our copyright in your system documentation, and comply with the 
  45.     transfer clause. 
  46.  
  47. YOU MAY NOT: 
  48.  
  49.  1. TRANSFER OR RENT THE PROGRAM OR USE, COPY OR  MODIFY THE PROGRAM EXCEPT AS 
  50.     PERMITTED IN THIS AGREEMENT. 
  51.  
  52.  2. DECOMPILE, REVERSE ASSEMBLE OR OTHERWISE REVERSE ENGINEER THE PROGRAM. 
  53.  
  54.  3. REPRODUCE, DISTRIBUTE OR REVISE THE PROGRAM DOCUMENTATION. 
  55.  
  56. LIMITED WARRANTY 
  57.  
  58. EXCEPT AS SPECIFICALLY STATED IN THIS AGREEMENT, THE PROGRAM IS PROVIDED "AS 
  59. IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT 
  60. NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 
  61. PARTICULAR PURPOSE. 
  62.  
  63. Syntegration warrants that the disk on which the Program is furnished will be 
  64. free from defects in materials and workmanship under normal use for a period of 
  65. 90 days from the date of delivery to you. 
  66.  
  67.  
  68. ΓòÉΓòÉΓòÉ 3. The Object Editor ΓòÉΓòÉΓòÉ
  69.  
  70. The Object Editor provides a convenient way to create, delete, or change the 
  71. settings of Workplace Shell objects. 
  72.  
  73. You can use this utility to edit object make files created by the Object 
  74. Manager or to create new ones. 
  75.  
  76. For details on the Object Edit, select from the list below: 
  77.  
  78.    o The Object Window 
  79.    o Object Editor Startup Options 
  80.    o The Action Log 
  81.  
  82.  
  83. ΓòÉΓòÉΓòÉ 3.1. The Object Editor Window ΓòÉΓòÉΓòÉ
  84.  
  85. The Object Editor window contains a set of controls that allow you to describe 
  86. workplace shell objects and edit the object list. for information on each item 
  87. select from the list below. 
  88.  
  89.  o Object description fields 
  90.  o Object style settings 
  91.  o Page controls 
  92.  
  93.  
  94. ΓòÉΓòÉΓòÉ 3.1.1. Object description fields ΓòÉΓòÉΓòÉ
  95.  
  96. Class 
  97.  
  98. This field specifies the object class of the object to be created You can 
  99. either select a class from the list box or enter your own class in the entry 
  100. field. The class must be registered before any create action will to be 
  101. successful. 
  102.  
  103. Title 
  104.  
  105. Enter the object title in this field. Use the caret character "^" as a line 
  106. delimiter when you want to create multiple line titles. 
  107.  
  108. Location 
  109.  
  110. You can select a location from the list box or enter your own location in the 
  111. entry field. This can be specified as either an ObjectID  or a file system 
  112. path. When you specify a path you must use a fully qualified path name such as 
  113. "c:\desktop\information". An ObjectID is delimited by the '<' and '>' 
  114. characters. The location must exist in the desktop for the action to be 
  115. successful. 
  116.  
  117. Object ID 
  118.  
  119. Enter the Object ID in this entry field. An object ID must include the '<' and 
  120. '>' delimiters as described for the location. Unlike the location This field 
  121. cannot contain a path name. 
  122.  
  123. Setup 
  124.  
  125. The Setup entry field allows you to describe attributes of the object. The 
  126. attributes are entered in "keyname=value" pairs. These pairs change the 
  127. behavior of the objects. "keynames" are separated by semicolons and "values" 
  128. are separated by commas. If you want a literal comma or a literal semicolon 
  129. inside one of the fields, enter the following: 
  130.  
  131.    o ^, A literal comma 
  132.    o ^; A literal semicolon. 
  133.  
  134.  Refer to the Object Creation section of your use's manual for more details. 
  135.  
  136.  Action 
  137.  
  138.  The Action list specifies the type of operation to be performed when the File 
  139.  Run command is invoked. The list allows selection of the following actions: 
  140.  
  141.    Create object, fail if exists 
  142.       To create a new object or fail if an object with the given ObjectID 
  143.       already exists. 
  144.  
  145.    Create object, replace if exists 
  146.       To create a new object or replace any existing object with the given 
  147.       OBJECTID. 
  148.  
  149.    Create object or update settings 
  150.       To create a new object or update the settings of any existing object with 
  151.       the given OBJECTID. The settings are updated with the information in the 
  152.       "Settings" window. 
  153.  
  154.    Delete object 
  155.       To delete the object with OBJECTID specified in the LOCATION field. 
  156.  
  157.    Setup object data 
  158.       To update the object specified in the Location field using data in the 
  159.       Setup, settings, and ObjectID fields. 
  160.  
  161.  
  162. ΓòÉΓòÉΓòÉ 3.1.2. Object Styles ΓòÉΓòÉΓòÉ
  163.  
  164. The object style checkboxes have 3 states. When the checkbox is disabled the 
  165. style will be defaulted in the create action and unchanged by an update action. 
  166. When the checkbox is checked the style will be set to YES. When the checkbox is 
  167. unchecked the style will be set to NO. 
  168.  
  169. Template 
  170.  
  171.    Checked        Sets the object's template style (ie.TEMPLATE=YES). 
  172.    Unchecked      Resets the object's template style (ie.TEMPLATE=NO). 
  173.  
  174.  No Copy 
  175.  
  176.    Checked        Will disallow object copying (ie.NOCOPY=YES). 
  177.    Unchecked      Updates the object style to allow the object to be copied 
  178.                   (ie."NOCOPY=NO;") 
  179.  
  180.  No Move 
  181.  
  182.    Checked        Will prevent the object from being moved to another folder. A 
  183.                   shadow will be created on a move if the "NOSHADOW" attribute 
  184.                   is not set. 
  185.    Unchecked      Resets the NOMOVE style allowing the object to be moved. 
  186.  
  187.  No Shadow 
  188.  
  189.    Checked        Will prevent shadow creation. 
  190.    Unchecked      Resets the NOSHADOW style allowing object shadows to be 
  191.                   created. 
  192.  
  193.  No Delete 
  194.  
  195.    Checked        Will prevent object deletion. 
  196.    Unchecked      Resets the attribute and allows the object to be deleted. 
  197.  
  198.  No Rename 
  199.  
  200.    Checked        Will disallow object Renaming. Use this attribute to prevent 
  201.                   a user from changing an object's title. 
  202.    Unchecked      Resets the attribute and allows the object to be renamed. 
  203.  
  204.  No Print 
  205.  
  206.    Checked        Will disallow object printing. 
  207.    Unchecked      Resets the NOPRINT style and allows the object to be printed. 
  208.  
  209.  No Drag 
  210.  
  211.    Checked        Will prevent the object from being dragged with a mouse. 
  212.    Unchecked      Resets the NODRAG style allowing the object to be picked up. 
  213.  
  214.  No Settings 
  215.  
  216.    Checked        Will remove the "Settings" item from the pop-up menu. 
  217.    Unchecked      Allows the "Settings" item in the pop-up menu. 
  218.  
  219.  No Details 
  220.  
  221.    Checked        Will remove the "OPEN DETAILS" item from a folder pop-up 
  222.                   menu. 
  223.    Unchecked      Allows the "OPEN DETAILS" item in a folder pop-up menu. 
  224.  
  225.  No Select 
  226.  
  227.    Checked        Will remove the "SELECT" item from a folder pop-up menu. 
  228.    Unchecked      Allows the "SELECT" item in the pop-up menu. 
  229.  
  230.  No Sort 
  231.  
  232.    Checked        Will remove the "SORT" item from the popup menu. 
  233.    Unchecked      Allows the "SORT" item in the popup menu. 
  234.  
  235.  No Arrange 
  236.  
  237.    Checked        Will remove the "ARRANGE" item from the popup menu. 
  238.    Unchecked      Allows the "ARRANGE" item in the popup menu. 
  239.  
  240.  
  241. ΓòÉΓòÉΓòÉ 3.1.3. Page Controls ΓòÉΓòÉΓòÉ
  242.  
  243. The buttons at the base of the Object Editor's window allow you to navigate 
  244. between the objects in the list and to perform record editing operations. The 
  245. Edit menu also gives you access to some of these operations. Each button is 
  246. descibed below. 
  247.  
  248. New 
  249.  
  250. The New button will insert a blank object record after the current object in 
  251. the list. 
  252.  
  253. Insert 
  254.  
  255. The Insert button will insert a blank record before the current object in the 
  256. list. 
  257.  
  258. Copy 
  259.  
  260. The Copy button will copy the current page to an internal scratch pad. The 
  261. scratch pad data can then be inserted into another page by using the Paste 
  262. pushbutton. 
  263.  
  264. Cut 
  265.  
  266. The Cut function will delete the current page and place a copy into the scratch 
  267. pad. 
  268.  
  269. Paste 
  270.  
  271. The Paste function will insert the data from the scratch pad into the current 
  272. page. 
  273.  
  274. Undo 
  275.  
  276. The Undo button will restore the currently displayed page to its original 
  277. state. 
  278.  
  279. Top 
  280.  
  281. The Top button will move you to the first item in the object list. 
  282.  
  283. Bottom 
  284.  
  285. The Bottom button will move you to the last item in the object list. 
  286.  
  287. Page Up 
  288.  
  289. The PgUp pushbutton will display the previous item in the list. 
  290.  
  291. Page Down 
  292.  
  293. The PgDown pushbutton will display the next item in the list. 
  294.  
  295.  
  296. ΓòÉΓòÉΓòÉ 3.2. Action Log ΓòÉΓòÉΓòÉ
  297.  
  298. When That File Run command is invoked an log window appears to give a record of 
  299. the success or failure of the actions as they are carried out. Pushbuttons in 
  300. the Action log window behave as follows: 
  301.  
  302.  o The "Save..." pushbutton will display a dialog box to allow entry of a file 
  303.    name to save the contents of the Action Log. 
  304.  
  305.  o The "Print" pushbutton will cause the contents of the Action Log to be 
  306.    printed on the default printer 
  307.  
  308.  o The "Cancel" pushbutton will dismiss the Action Log window. 
  309.  
  310.  
  311. ΓòÉΓòÉΓòÉ 3.3. The Menu ΓòÉΓòÉΓòÉ
  312.  
  313. The following pages describe the Object Editor's Menu options. 
  314.  
  315.  
  316. ΓòÉΓòÉΓòÉ 3.3.1. File Menu ΓòÉΓòÉΓòÉ
  317.  
  318. The File menu contains commands that you use to create, open, save, and print 
  319. data files. In addition, it also contains the command that you use to exit the 
  320. application. The following commands appear in the File menu: 
  321.  
  322.  New            Creates a new untitled file 
  323.  
  324.  Open           Opens an existing file 
  325.  
  326.  Save           Saves any changes to current file 
  327.  
  328.  Save As        Saves the current file using a new name 
  329.  
  330.  Print          Prints the current object list file 
  331.  
  332.  Run            Performs the actions in each item in the object make file 
  333.  
  334.  
  335. ΓòÉΓòÉΓòÉ 3.3.1.1. File New ΓòÉΓòÉΓòÉ
  336.  
  337. Use New to replace the current file with a new file named Untitled. If the 
  338. current file has been modified, you will be asked if you want to save it before 
  339. continuing. 
  340.  
  341.  
  342. ΓòÉΓòÉΓòÉ 3.3.1.2. File Open ΓòÉΓòÉΓòÉ
  343.  
  344. Use the Open command to access a file that exists on any drive or in any 
  345. directory. 
  346.  
  347.  
  348. ΓòÉΓòÉΓòÉ 3.3.1.3. File Save ΓòÉΓòÉΓòÉ
  349.  
  350. Use the Save command to save changes you made to your object list file. 
  351.  
  352.  
  353. ΓòÉΓòÉΓòÉ 3.3.1.4. File Save As ΓòÉΓòÉΓòÉ
  354.  
  355. Use the Save As command to name and save a new file. 
  356.  
  357. Follow these steps to save a new file: 
  358.  
  359.   1. Select the File menu and choose the Save As command. 
  360.  
  361.  A dialog box appears, prompting you for a new filename. 
  362.  
  363.  
  364. ΓòÉΓòÉΓòÉ 3.3.1.5. File Print ΓòÉΓòÉΓòÉ
  365.  
  366. Use the Print command to print an Object Make file. 
  367.  
  368.  
  369. ΓòÉΓòÉΓòÉ 3.3.1.6. File Run ΓòÉΓòÉΓòÉ
  370.  
  371. Use the Run command to perform the actions described for each item in the 
  372. object list. 
  373.  
  374.  
  375. ΓòÉΓòÉΓòÉ 3.3.2. Edit Menu ΓòÉΓòÉΓòÉ
  376.  
  377. The Edit menu contains commands that you use to cut, copy, and paste pages. The 
  378. following commands appear in the Edit menu: 
  379.  
  380.  Cut            Copies current page to a scratch area and removes it from the 
  381.                 action list. 
  382.  
  383.  Copy           Copies current page to a scratch area. 
  384.  
  385.  Paste          Pastes the scratch pad data into the current page. 
  386.  
  387.  
  388. ΓòÉΓòÉΓòÉ 3.3.3. Help Menu ΓòÉΓòÉΓòÉ
  389.  
  390. Use the choices on the Help menu to display: 
  391.  
  392.    o An index of references to the help topics for the active program 
  393.  
  394.    o General information about the contents of the active window 
  395.  
  396.    o General information about the help facility 
  397.  
  398.    o A list and description of keys you can use 
  399.  
  400.    o Product information for the active program. 
  401.  
  402.  
  403. ΓòÉΓòÉΓòÉ 3.3.3.1. Help For Help ΓòÉΓòÉΓòÉ
  404.  
  405. To get information on a particular item, place the cursor on the item then 
  406. press the Help Key (F1). 
  407.  
  408.  
  409. ΓòÉΓòÉΓòÉ 3.3.3.2. Keys Help ΓòÉΓòÉΓòÉ
  410.  
  411. <PAGE UP> and <PAGE DOWN> changes the displayed page. 
  412.  
  413.  
  414. ΓòÉΓòÉΓòÉ 3.3.3.3. Help for Help Index ΓòÉΓòÉΓòÉ
  415.  
  416. Use the Help index to display an alphabetical list of references to help topics 
  417. in the active program. 
  418.  
  419. You can select an index entry to display the Help topic related to that index 
  420. entry. 
  421.  
  422.  
  423. ΓòÉΓòÉΓòÉ 3.3.3.4. Product Information ΓòÉΓòÉΓòÉ
  424.  
  425. Select this menu item to display the product information window. 
  426.  
  427.  
  428. ΓòÉΓòÉΓòÉ 3.4. Object Editor Startup Options ΓòÉΓòÉΓòÉ
  429.  
  430. When starting the Object Editor from a command prompt you can specify options. 
  431. The command line syntax is as follows: 
  432.  
  433. OBJEDIT filename [ options ] 
  434.  
  435. filename specifies an Object make file containing a list of objects and actions 
  436. to be performed. The Program will read this file then allow you to edit the 
  437. objects or execute the actions. 
  438.  
  439. The following options are allowed. 
  440.  
  441.      /NOLOGO 
  442.         Do not display the initial product information screen 
  443.  
  444.      /LOG[=LogFile] 
  445.         Log all operations to the specified logfile. If no log file is 
  446.         specified the program will write to OBJEDIT.LOG in the current 
  447.         directory. 
  448.  
  449.      /HOME=OBJECTID 
  450.         allows you to specify an OBJECTID on the command line. The object maker 
  451.         will substitute the OBJECTID in the LOCATION or SETUP strings where it 
  452.         finds the keyword "<HOME>" 
  453.  
  454.      /RUN[=RunFile] 
  455.         specifies that the actions described in the object list should be 
  456.         performed. if RunFile is specified then it is assumed to contain the 
  457.         object list. 
  458.  
  459.  The command line below invokes the Object Editor to execute the instructions 
  460.  in the MYOBJECTS.OMF make file. The initial logo screen is not displayed. 
  461.  
  462.  
  463.     OBJMAKE /NOLOGO /RUN=MYOBJECTS.OMF
  464.  
  465.  The following example shows the format of an Object Make File. Blank lines are 
  466.  ignored. Comment lines start with an asterisk. 
  467.  
  468.   ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
  469.   Γöé*                                                                Γöé
  470.   Γöé*  Create a Folder on the desktop or                             Γöé
  471.   Γöé*  update the settings if it already exists                      Γöé
  472.   Γöé*                                                                Γöé
  473.   ΓöéCLASS    "WPFolder"                                              Γöé
  474.   ΓöéTITLE    "The Secure Workplace Utilities"                        Γöé
  475.   ΓöéLOCATION "<WP_DESKTOP>"                                          Γöé
  476.   ΓöéSETUP    "NORENAME=YES;NODELETE=YES;OBJECTID=<SWU_MAIN>;"        Γöé
  477.   ΓöéACTION   U                                                       Γöé
  478.   Γöé                                                                 Γöé
  479.   Γöé*                                                                Γöé
  480.   Γöé*  Create a Program object or                                    Γöé
  481.   Γöé*  update the settings if it already exists                      Γöé
  482.   Γöé*                                                                Γöé
  483.   ΓöéCLASS    "WPProgram"                                             Γöé
  484.   ΓöéLOCATION "<SWU_MAIN>"                                            Γöé
  485.   ΓöéTITLE    "Object Editor"                                         Γöé
  486.   ΓöéSETUP    "PROGTYPE=PM;"                                          Γöé
  487.   ΓöéSETUP    "EXENAME=objedit.exe;"                                  Γöé
  488.   ΓöéSETUP    "ASSOCFILTER=*.OMF;"                                    Γöé
  489.   ΓöéSETUP    "NOCOPY=YES;"                                           Γöé
  490.   ΓöéSETUP    "NORENAME=YES;"                                         Γöé
  491.   ΓöéSETUP    "NOLINK=YES;"                                           Γöé
  492.   ΓöéSETUP    "NOMOVE=YES;"                                           Γöé
  493.   ΓöéSETUP    "OBJECTID=<SWU_OBJECTEDITOR>;"                          Γöé
  494.   ΓöéACTION   U                                                       Γöé
  495.   Γöé                                                                 Γöé
  496.   Γöé*                                                                Γöé
  497.   Γöé* Update the settings of the object with ObjectID=<SWU_MAIN>     Γöé
  498.   Γöé*                                                                Γöé
  499.   ΓöéLOCATION "<SWU_MAIN>"                                            Γöé
  500.   ΓöéSETUP    "DETAILSVIEW=FLOWED"                                    Γöé
  501.   ΓöéACTION   E                                                       Γöé
  502.   Γöé                                                                 Γöé
  503.   Γöé*                                                                Γöé
  504.   Γöé* Delete the object with ObjectID=<SWU_OBJECTEDITOR>             Γöé
  505.   Γöé*                                                                Γöé
  506.   ΓöéLOCATION "<SWU_OBJECTEDITOR>"                                    Γöé
  507.   ΓöéACTION   D                                                       Γöé
  508.   ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
  509.